How Users Can Submit Feedback About Search Results

 

Feedback Features

SmartHub contains two features for submitting feedback:

  • Content Feedback:
    • Enables the users to submit feedback about a specific query result (such as a document) via e-mail.
  • Page Feedback:
    • Enables the user to submit feedback about the current search session via e-mail.

About Content Feedback

The Content Feedback competent can be used by users to report content issues.

The Content Feedback button  can be found in the action bar for each result.

Clicking the button opens a modal window that displays:

  • Result title
  • Result URL
  • The option to select the issue from three predefined issues:
    • Access issue
    • Old/Outdated content
    • Inappropriate content
  • The option to provide additional details about the issue with that result
  • Click Send to send an email using your local email client.

How to Customize Your Content Feedback Component

Before continuing, familiarize yourself with the information in the topic How to Use the UI Builder.

UI Builder

  • The easiest and fastest way to insert and customize Content Feedback is via the SmartHub UI Builder.

  • For more information, see How to Use the UI Builder.

Procedure:

  1. SmartHub administrators can simply click the UI Editor link from the SmartHub Administration page.

  2. Click the Select a page link from the top menu.

  3. Select (double-click) an HTML page such as Results.html page.

    1. Below, the Results.html page is shown for sample purposes.

    2. BA Insight recommends you use page and folder to modify. Leave the default files as templates.

      1. Example: Customizations/CustomResults.html. Default Results.html is under the top most SmartHub directory.

      2. See Creating Custom Pages.

  4. Select the Advanced mode from the top right of the page.

  5. Select Advanced settings edit.

  6. Scroll down to line 259 (this may vary), which contains the text SH.ContentFeedback.CustomSettings

  7. Click the link Default Settings at the top right.

  8. A new browser tab opens with all available SmartHub module settings.

  9. Search for the word "ContentFeedback" on the page to quickly navigate to the Ratings default settings, shown below:
    10. Copy 
        SH.ContentFeedback = SH.ContentFeedback || {};
        SH.ContentFeedback.DefaultSettings = {
            Title: "Content Feedback",
            ContentModalTemplatePath: SH.RootLevelURL + "/modules/ContentFeedback/templates/contentFeedbackTemplate.html",
            MailTo: "search@bainsight.com",
            FeedbackReasons: [
                "I should not see this (access issue).".toLocaleString(),
                "Old/Outdated content.".toLocaleString(),
                "Innapropriate content.".toLocaleString()
            ],
            ModuleDetails: {
                label: 'Feedback',
                iconClass: 'fas fa-envelope',
                btnClass: 'contentFeedbackBtn'
            }
        }
  10. Copy the ContentFeedback settings section from SH.ContentFeedback.DefaultSettings.
  11. Go back to your Advanced settings edit tab.

  12. Paste the copied settings inside section SH.ContentFeedback.CustomSettings.

    • Note: The Enabled value is commented out by default.

  13. Modify settings as desired. Refer to the "Feedback Settings" table below.

  14. Click Save changes.

  15. Click the link Preview <html> file.html at the top of the code editor.

  16. Review your HTML page in the new tab that opens.

  17. Make any necessary changes back in the code editor. Repeat steps 14-18 as necessary.

  18. Click Save changes.

How to enable content feedback in a content container

Enabling content feedback in a content container is done using the SH.ContentContainer.CustomSettings section from your CustomSettings file. See the following sample code for the main results ContentContainer:

Copy 
SH.ContentContainers.CustomSettings = {  
    ContentContainers: {       
        MainResults: {            
            EnableResultFeedback: true
        }
    }
}

About the Page Feedback Component

  • The Page Feedback component is similar to the Content Feedback component, and it can be used by users to report page issues.

  • The Page Feedback button can be found at the bottom of the results page.

  • The Page Feedback component has the following characteristics:

    • It enables the user to submit feedback via e-mail about:

      • Current page (URL) they are on

      • Issue

      • Comments

How to Customize the Page Feedback Component

In the DefaultModuleSettings.js file, change the default parameters for the Page Feedback Module.

Copy 
    SH.PageFeedback = SH.PageFeedback || {};
    SH.PageFeedback.DefaultSettings = {
        Title: "Page Feedback",
        PageModalTemplatePath: SH.RootLevelURL + "/modules/PageFeedback/templates/pageFeedbackTemplate.html",
        PageFeedbackEnabled: true,
        ButtonTitle: "Search Results Feedback",
        MailTo: "search@bainsight.com",
        FeedbackReasons: [
            "I should not see this (access issue).".toLocaleString(),
            "Old/Outdated content.".toLocaleString(),
            "No results.".toLocaleString()
        ]
    };

Feedback settings parameters

Setting Name Default Value Description
Title Page Feedback Module Title
PageModalTemplatePath /modules/PageFeedback/templates/pageFeedbackTemplate.html Path to html template used for the module
PageFeedbackEnabled true Enable/Disable module
ButtonTitle Search Results Feedback Button title
MailTo search@bainsight.com Email address
FeedbackReasons "I should not see this (access issue).", "Old/Outdated content.", "No Results." Feedback reasons

Enabling page feedback is done using the SH.PageFeedback.CustomSettings section of your CustomSettings file. See the following sample code:

Copy 
SH.PageFeedback.CustomSettings = {
    PageFeedbackEnabled: true
}